Report Definition form

Operations Reports Report Definitions Report Definitions view Report Definition form

The Report Definition form enables you to add and edit a report definition. A report definition contains the data and format information required to create a report document. Each report definition is based on a report design (on page 1).

To add or edit a report definition:

  1. In the Report Definition Name field, enter a name that uniquely identifies the report definition.

  1. Optionally, in the Description field, enter a description of the purpose of the report definition.

  2. Optionally, in the Report Display Title field, enter a title that will be used in the report document.

If you do not specify a report title, the ID of the associated report design will be used in the report document.

  1. From the Reporting Entity drop-down list, select the business entity type for the report definition.

  2. From the Report Design drop-down list, select the report design to use as a base for the report definition.

The available report designs are determined by the business entity type selected in step 4 above.

  1. From the Output Type drop-down list, select the default output type for the report document.

You can select one of the following available output types:

You can still select a different output type every time you run the report.

  1. Optionally, in the Role field, you can associate a role with each report definition. For more information on the rules for associating a role with a report definition, see Associate a role with a report definition (on page 1).

  2. Optionally, in the Sort Fields area, select up to three sort fields and the sort order (Ascending/Descending) for each field.

The sort order will determine the order of the records displayed in the report document.

Computed reporting fields are not database fields and are therefore not available for sorting in N4. However, you can sort a report by a computed field when setting up the report using iReport. For more information, see the topic How do I sort a report by a computed field?

  1. Optionally, in the Filter Criteria area, create a filter to restrict the information included in the report.

For example, you can create a filter that displays containers for a specific line operator. For more information on editing, moving, or copying filter criteria, see Editing a filter or a mapping rule.

It is recommended that you parameterize filter criteria created for report definitions (see Add a parameter to a filter criterion).

If you you modify the name of a parameter in the report definition filter, you must modify the report design accordingly.

  1. Click Save to save the report definition, or click Run Report to run the report definition without saving it.

If you save a report definition, it is displayed in the Report Definitions view (on page 1) and you can use it to generate reports any number of times. You can also duplicate a saved report definition (on page 1) if you want to add a similar report with minor differences.

The Run Report button is available only when you are editing an existing report definition. If you are adding a new report definition, you must save the report definition before you run it. N4 displays an error message and does not allow you to download the reports if the report contains empty records

Output file types

On your workstation, you must associate each output file type with an application that can open it. For example, you might associate the RTF file type with Microsoft Word, CSV file type with Microsoft Excel, and the PDF file type with Adobe Acrobat Reader. When a report document is created, it opens in the associated application from which you can save or print it.

See your operating system documentation for information about associating a file type with an application.